RX400 API Documentation

Version: 1.0.0

Official API Documentation rx400 copy station

Schemes:

Summary

Tag: Ticket Endpoints

Operation Description
POST /api/ticket/new/ Create a new ticket.
POST /api/ticket/{id}/start/ Start a ticket.
POST /api/ticket/{id}/stop/ Stop a ticket.
POST /api/ticket/{id}/delete/ Delete a ticket.

Tag: Status calls

Operation Description
GET /api/status/ticket/ Get status information for all tickets.
GET /api/status/ticket/{id} Get status information for given ticket.
GET /api/status/jobs/ Get status information for all jobs.
GET /api/status/jobs/{id} Get status information for given job.

Tag: De-/Assigning

Operation Description
POST /api/assign/ticket Assign a ticket.
POST /api/deassign/ticket Deassign a ticket.

Paths

POST /api/assign/ticket

Tags: De-/Assigning

Assign a Ticket

ticket_id

ID of ticket to assign

query object
slot_id

ID of slot to assign

query object
200 OK

OK

POST /api/deassign/ticket

Tags: De-/Assigning

Deassign a Ticket

ticket_id

ID of ticket to assign

query object
slot_id

ID of slot to assign

query object
200 OK

OK

GET /api/status/jobs/

Tags: Status calls

Get Status information for all jobs

200 OK

OK

GET /api/status/jobs/{id}

Tags: Status calls

Get Status information for jobs by ID

id

Ticket ID

path object
200 OK

OK

GET /api/status/ticket/

Tags: Status calls

Get Status information for all tickets

200 OK

OK

GET /api/status/ticket/{id}

Tags: Status calls

Get Status information for ticket by ID

id

Ticket ID

path object
200 OK

OK

POST /api/ticket/new/

Tags: Ticket Endpoints

Create new Tickets

data

Ticket Data in JSON format

query object
Example ticket data
200 OK

OK

POST /api/ticket/{id}/delete/

Tags: Ticket Endpoints

Delete a Ticket.

id

Ticket ID

path object
200 OK

OK

POST /api/ticket/{id}/start/

Tags: Ticket Endpoints

Start a Ticket.

id

Ticket ID

path object
200 OK

OK

POST /api/ticket/{id}/stop/

Tags: Ticket Endpoints

Stop a Ticket.

id

Ticket ID

path object
200 OK

OK